Add sphinx-gallery #210
Merged
Add sphinx-gallery #210
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mx-moth
force-pushed
the
dual-plot-example
branch
from
207870c to
8098f50
Compare
Previously disabled because they didn't work well with a previous theme, but the lack of module names was making it hard to actually determine where a function, class, etc was importable from.
mx-moth
force-pushed
the
dual-plot-example
branch
2 times, most recently
from
e160578 to
cc44dc2
Compare
mx-moth
force-pushed
the
dual-plot-example
branch
from
cc44dc2 to
eff52cb
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Now that there are more examples in the documentation, generating the plots and updating the gallery list is becoming a chore. sphinx-gallery automates this, and is what is used by matplotlib to generate their galleries. This PR adds sphinx-gallery to the project and migrates the examples to use it.
One upside of this is that the generated images are no longer included in the repository which will save on repository file size as we add more examples. One downside of this is that the documentation now takes longer to build.